Skip to content

networkx: fix subgraph and degree #14390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

AckslD
Copy link
Contributor

@AckslD AckslD commented Jul 9, 2025

Two small fixes to networkx, let me know if it's better with separate PRs:

  1. Graph.subgraph can also take a single node.
  2. If eg degree takes a single node, the return type is different so add overloads.

@AckslD
Copy link
Contributor Author

AckslD commented Jul 9, 2025

Hmm, degree works differently if the first argument is None vs any other Hashable, not sure how to type that.

This comment has been minimized.

Copy link
Collaborator

@srittau srittau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, remarks below.

@overload
def __call__(self, nbunch: _Node, weight: None | bool | str = None) -> int: ...
@overload
def __call__(self, nbunch: Iterable[_Node] | None = None, weight: None | bool | str = None) -> DiDegreeView[_Node]: ...
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably overly pedantic, but this doesn't necessarily return a DiDegreeView, but could also return a sub-class if called on an instance of a sub-class. So Self is more appropriate:

Suggested change
def __call__(self, nbunch: Iterable[_Node] | None = None, weight: None | bool | str = None) -> DiDegreeView[_Node]: ...
def __call__(self, nbunch: Iterable[_Node] | None = None, weight: None | bool | str = None) -> Self: ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point, fixed

@@ -55,7 +55,10 @@ class NodeDataView(AbstractSet[_Node]):

class DiDegreeView(Generic[_Node]):
def __init__(self, G: Graph[_Node], nbunch: _NBunch[_Node] = None, weight: None | bool | str = None) -> None: ...
def __call__(self, nbunch: _NBunch[_Node] = None, weight: None | bool | str = None) -> int | DiDegreeView[_Node]: ...
@overload
def __call__(self, nbunch: _Node, weight: None | bool | str = None) -> int: ...
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__getitem__ returns float, so this should also return float:

Suggested change
def __call__(self, nbunch: _Node, weight: None | bool | str = None) -> int: ...
def __call__(self, nbunch: _Node, weight: None | bool | str = None) -> float: ...

Copy link
Contributor Author

@AckslD AckslD Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm shouldn't the degree always be an integer, at least this passes:

import networkx as nx
g = nx.Graph()
g.add_node('a')
assert type(g.degree('a')) is int

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no experience with networkx, so I can't say either way, I just noticed that __getitem__ return float (which is equivalent to int | float, so I was going by that. If you say that this will always be int, I'll believe you.

@AckslD
Copy link
Contributor Author

AckslD commented Jul 10, 2025

@srittau I tried something when nbunch = None but that also doesn't work, any suggestions how to distinguish that from other hashables?

Copy link
Contributor

Diff from mypy_primer, showing the effect of this PR on open source code:

bokeh (https://github.com/bokeh/bokeh)
+ src/bokeh/models/util/structure.py:165: note: ... from here:

@srittau
Copy link
Collaborator

srittau commented Jul 11, 2025

@srittau I tried something when nbunch = None but that also doesn't work, any suggestions how to distinguish that from other hashables?

We'll need a # type: ignore[overload-overlap] on the offending line. Unfortunately, mypy's overlap check is sometimes a bit over eager.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants